Skip to content

[pull] master from marmelab:master#21

Merged
pull[bot] merged 23 commits into
Stars1233:masterfrom
marmelab:master
Jun 3, 2025
Merged

[pull] master from marmelab:master#21
pull[bot] merged 23 commits into
Stars1233:masterfrom
marmelab:master

Conversation

@pull

@pull pull Bot commented Jun 3, 2025

Copy link
Copy Markdown

See Commits and Changes for more details.


Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

Replace the legacy Datagrid with a new DataTable API across tutorials, field type mappings, guessers, stories, and tests; update code examples and CLI commands accordingly.

New Features:

  • Introduce the DataTable and DataTable.Col components as the new table primitives replacing Datagrid

Enhancements:

  • Migrate the tutorial, docs, and examples from Datagrid to DataTable with updated children and field prop support
  • Wrap all default list and show field types in DataTable.Col and update listFieldTypes and showFieldTypes to use DataTable
  • Improve ListGuesser and ShowGuesser to filter out nested component matches and provide log-enabled story variants

Documentation:

  • Update Tutorial.md to use DataTable examples and add --interactive flag to the create-react-admin command

Tests:

  • Update ListGuesser and ShowGuesser specs to validate logging of guessed configurations through simulated UI interactions

@pull pull Bot added the ⤵️ pull label Jun 3, 2025
@pull pull Bot merged commit 5cf92ae into Stars1233:master Jun 3, 2025
@sourcery-ai

sourcery-ai Bot commented Jun 3, 2025

Copy link
Copy Markdown

Reviewer's Guide

This PR renames the Datagrid component to DataTable across the tutorial, UI library mappings, guesser logic, stories, and tests; wraps fields in DataTable.Col; adds an --interactive flag to the CLI bootstrapping commands; and adds filtering to the guesser extractors to avoid dotted component names.

Sequence Diagram: Interactive CLI Project Setup

sequenceDiagram
    actor User
    participant CLI as "create-react-admin CLI"
    User->>CLI: Executes `npm create react-admin ... -- --interactive`
    CLI-->>User: Prompt: Choose Data Provider
    User->>CLI: Selects Data Provider
    CLI-->>User: Prompt: Choose Auth Provider
    User->>CLI: Selects Auth Provider
    CLI-->>User: Prompt: Add resources
    User->>CLI: Provides resource information (or none)
    CLI-->>User: Prompt: Choose package manager
    User->>CLI: Selects package manager
    CLI->>CLI: Installs dependencies
    CLI->>CLI: Scaffolds project files
    CLI-->>User: Output: Project created successfully
Loading

ER Diagram: Updated Data Structures in Storybook Examples

erDiagram
    Product {
        int id PK
        string name
        float price
        date last_update "new"
        string email "new"
        int category_id FK
    }

    Category {
        int id PK
        string name
        string alternativeName "new, list of names"
        boolean isVeganProduction "new"
    }

    Tag {
        int id PK
        string name
        string url "new"
    }

    Product ||--o{ Category : "belongs to (one)"
    Product }o--o{ Product_Tag_Relation : "has (many via)"
    Tag     }o--o{ Product_Tag_Relation : "associated with (many via)"

    Product_Tag_Relation {
        int product_id PK, FK
        int tag_id PK, FK
    }
Loading

File-Level Changes

Change Details Files
Update tutorial to use DataTable instead of Datagrid
  • Add --interactive flag to npm and yarn create-react-admin commands
  • Replace imports of Datagrid with DataTable in examples
  • Wrap fields in <DataTable> and <DataTable.Col> tags
  • Update narrative references from Datagrid to DataTable
docs/Tutorial.md
Rename default list component in UI library from Datagrid to DataTable
  • Change table mapping to render <DataTable> instead of <Datagrid>
  • Adjust representation templates from <Datagrid> to <DataTable>
  • Wrap array, boolean, date, email, reference, referenceArray fields inside <DataTable.Col>
  • Use DataTable.NumberCol and <DataTable.Col> for id, string, url, and number types
packages/ra-ui-materialui/src/list/listFieldTypes.tsx
Refactor ListGuesser to use DataTable and update related stories/tests
  • Implement ManyResources story with new sample data and DataTable usage
  • Update ListGuesser spec to use fireEvent/screen and expect DataTable-based console logs
  • Modify guessed code output to import/use DataTable, DataTable.Col, and related fields
packages/ra-ui-materialui/src/list/ListGuesser.stories.tsx
packages/ra-ui-materialui/src/list/ListGuesser.spec.tsx
Refactor ShowGuesser to use DataTable in representations and update stories/tests
  • Create ShowGuesser.stories.tsx using DataTable for array and nested fields
  • Update showFieldTypes to wrap ArrayField children in <DataTable> and <DataTable.Col>
  • Adjust ShowGuesser spec to validate DataTable-based guessed show output
packages/ra-ui-materialui/src/detail/ShowGuesser.stories.tsx
packages/ra-ui-materialui/src/detail/showFieldTypes.tsx
packages/ra-ui-materialui/src/detail/ShowGuesser.tsx
packages/ra-ui-materialui/src/detail/ShowGuesser.spec.tsx
Add filtering to ListGuesser and ShowGuesser component extraction
  • Filter out nested/dotted component names in guessed view extraction logic
  • Apply .filter(component => !component.match(/[A-Za-z]+\.[A-Za-z]+/i)) to both guessers
packages/ra-ui-materialui/src/list/ListGuesser.tsx
packages/ra-ui-materialui/src/detail/ShowGuesser.tsx

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai

coderabbitai Bot commented Jun 3, 2025

Copy link
Copy Markdown

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants